home *** CD-ROM | disk | FTP | other *** search
/ DOpus Plus / DOpus Plus.iso / SDK / docs / progress.doc < prev    next >
Encoding:
Text File  |  1998-10-26  |  8.1 KB  |  256 lines

  1. dopus5.library/CheckProgressAbort           dopus5.library/CheckProgressAbort
  2.  
  3.     NAME
  4.         CheckProgressAbort - check for abort in progress window
  5.  
  6.     SYNOPSIS
  7.         CheckProgressAbort(handle)
  8.                              A0
  9.  
  10.         BOOL CheckProgressAbort(APTR);
  11.  
  12.     FUNCTION
  13.         Allows you to check the state of the abort flag in the specified
  14.         progress window.
  15.  
  16.     INPUTS
  17.         handle - progress window handle
  18.  
  19.     RESULT
  20.         Returns TRUE if the Abort button has been clicked.
  21.  
  22.     SEE ALSO
  23.         OpenProgressWindow()
  24.  
  25. dopus5.library/CloseProgressWindow         dopus5.library/CloseProgressWindow
  26.  
  27.     NAME
  28.         CloseProgressWindow - close a progress window
  29.  
  30.     SYNOPSIS
  31.         CloseProgressWindow(handle)
  32.                               A0
  33.  
  34.         void CloseProgressWindow(APTR);
  35.  
  36.     FUNCTION
  37.         Closes the specified progress window.
  38.  
  39.     INPUTS
  40.         handle - progress window to close
  41.  
  42.     SEE ALSO
  43.         OpenProgressWindow()
  44.  
  45. dopus5.library/GetProgressWindow             dopus5.library/GetProgressWindow
  46.  
  47.     NAME
  48.         GetProgressWindow - get progress window information
  49.  
  50.     SYNOPSIS
  51.         GetProgressWindow(handle, tags)
  52.                             A0     A1
  53.  
  54.         void GetProgressWindow(APTR, struct TagItem *);
  55.  
  56.         void GetProgressWindowTags(APTR, Tag, ...);
  57.  
  58.     FUNCTION
  59.         Returns information about the progress window. Currently available
  60.         information is :
  61.  
  62.             PW_Window      - returns Window pointer
  63.  
  64.     INPUTS
  65.         handle - progress window handle
  66.         tags   - inquiry tags
  67.  
  68.     RESULT
  69.         The result of each tag query is stored in the ti_Data field of the
  70.         TagItem.
  71.  
  72.     SEE ALSO
  73.         OpenProgressWindow(), SetProgressWindow()
  74.  
  75. dopus5.library/HideProgressWindow           dopus5.library/HideProgressWindow
  76.  
  77.     NAME
  78.         HideProgressWindow - hide a progress window
  79.  
  80.     SYNOPSIS
  81.         HideProgressWindow(handle)
  82.                              A0
  83.  
  84.         void HideProgressWindow(APTR);
  85.  
  86.     FUNCTION
  87.         Removes the specified progress window from the display. The progress
  88.         window is still operative; it can still be updated and even closed
  89.         while it is hidden.
  90.  
  91.     INPUTS
  92.         handle - progress window handle
  93.  
  94.     SEE ALSO
  95.         OpenProgressWindow(), ShowProgressWindow()
  96.  
  97. dopus5.library/OpenProgressWindow           dopus5.library/OpenPRogressWindow
  98.  
  99.     NAME
  100.         OpenProgressWindow - open a progress window display
  101.  
  102.     SYNOPSIS
  103.         OpenProgressWindow(tags)
  104.                             A0
  105.  
  106.         APTR OpenProgressWindow(struct TagItem *);
  107.  
  108.         APTR OpenProgressWindowTags(Tag, ...);
  109.  
  110.     FUNCTION
  111.         Opens a progress window that your application can use to display the
  112.         progression of some operation. The progress window can have a filename
  113.         display, file counter and progress guage.
  114.  
  115.     INPUTS
  116.         tags - control tags. Control tags are:
  117.  
  118.             PW_Screen    - screen to open on. The progress window will
  119.                            appear centered in the screen. Use of this tag
  120.                            overrides PW_Window.
  121.  
  122.             PW_Window    - window to open over. The progress window will
  123.                            appear centered over the supplied window.
  124.  
  125.             PW_Title     - title for the progress window
  126.  
  127.             PW_SigTask   - task to signal when the abort gadget is pressed.
  128.  
  129.             PW_SigBit    - bit to signal task with (signal bit, not mask)
  130.  
  131.             PW_FileName  - initial filename for display
  132.  
  133.             PW_FileSize  - initial file size
  134.     
  135.             PW_FileCount - initial file count
  136.  
  137.             PW_Flags     - control flags
  138.  
  139.         The control flags for the PW_Flags tag are :
  140.  
  141.             PWF_FILENAME  - specify if you want a filename display
  142.             PWF_FILESIZE  - specify if you want a file size display (1)
  143.             PWF_INFO      - specify if you want an information line
  144.             PWF_INFO2     - specify if you want a second information line
  145.             PWF_INFO3     - specify if you want a third information line
  146.             PWF_GRAPH     - specify if you want a bar graph display (1)
  147.             PWF_NOABORT   - specify if you don't want an Abort button (2)
  148.             PWF_INVISIBLE - if you want the progress window to open in 'hidden'
  149.                             mode (ie you need to call ShowProgressWindow() to
  150.                             make it visible)
  151.             PWF_ABORT     - specify if you do want an Abort button (2)
  152.  
  153.         1. Ordinarily, the file size is displayed as a "xxxxxx bytes" string in
  154.            the top-right of the progress window, and the bar graph is used to
  155.            represent "x out of y files". If, however, you specify both
  156.            PWF_FILESIZE and PWF_GRAPH, the meanings of these displays is
  157.            automatically swapped around. The current file progress (eg bytes
  158.            copied) is displayed in the bar graph, and the current operation
  159.            progress (eg files copied) is displayed in text in the top-right
  160.            corner.
  161.  
  162.         2. If you specify a signal task with the pw_SigTask flag, the
  163.            progress window will automatically get an Abort button. You can use
  164.            the PWF_NOABORT flag to stop this happening.
  165.  
  166.            If you do not specify the pw_SigTask flag, you can use the PWF_ABORT
  167.            flag to add an Abort button without signalling (you will need to
  168.            call CheckProgressAbort() to detect an abort).
  169.  
  170.     RESULT
  171.         Returns a handle to the newly created progress window, or NULL for
  172.         failure.
  173.  
  174.     SEE ALSO
  175.         SetProgressWindow(), CloseProgressWindow()
  176.  
  177. dopus5.library/SetProgressWindow             dopus5.library/SetProgressWindow
  178.  
  179.     NAME
  180.         SetProgressWindow - update progress window information
  181.  
  182.     SYNOPSIS
  183.         SetProgressWindow(handle, tags)
  184.                             A0     A1
  185.  
  186.         void SetProgressWindow(APTR, struct TagItem *);
  187.  
  188.         void SetProgressWindowTags(APTR, Tag, ...);
  189.  
  190.     FUNCTION
  191.         This is the routine you use to update the information displayed in
  192.         a progress window.
  193.  
  194.     INPUTS
  195.         handle - progress window handle
  196.         tags   - control tags. Valid tags are :
  197.  
  198.             PW_Title       - change the window title
  199.  
  200.             PW_FileName    - change the displayed filename
  201.  
  202.             PW_FileSize    - change the total size of the current file
  203.  
  204.             PW_FileDone    - change the "done" size of the current file
  205.                              (eg, if the file size was 12800 and you had
  206.                              copied half of it, the done size would be
  207.                              6400).
  208.  
  209.             PW_Info        - change the information field display
  210.  
  211.             PW_Info2       - change the second information field display
  212.  
  213.             PW_Info3       - change the third information field display
  214.  
  215.             PW_FileCount   - change the total number of files
  216.  
  217.             PW_FileNum     - change the number of files processed (eg,
  218.                              if the total file count was 84 and you had
  219.                              processed a quarter of them, the current
  220.                              file number would be 21).
  221.  
  222.     RESULT
  223.         The changes are displayed immediately. If the progress window is
  224.         currently hidden, the changes are still effective and will be
  225.         visible when the progress window is revealed.
  226.  
  227.     SEE ALSO
  228.         OpenProgressWindow()
  229.  
  230. dopus5.library/ShowProgressWindow           dopus5.library/ShowProgressWindow
  231.  
  232.     NAME
  233.         ShowProgressWindow - reveal a hidden progress window
  234.  
  235.     SYNOPSIS
  236.         ShowProgressWindow(handle, screen, window)
  237.                              A0      A1      A2
  238.  
  239.         void ShowProgressWindow(APTR, struct Screen *, struct Window *);
  240.  
  241.     FUNCTION
  242.         Reveals a progress window that was hidden with HideProgressWindow().
  243.  
  244.     INPUTS
  245.         handle - progress window handle
  246.         screen - new parent screen (if no window supplied)
  247.         window - new owner window (if no screen supplied)
  248.  
  249.     RESULT
  250.         The progress window is revealed. If possible, it will be displayed
  251.         at the same position on the screen as it was when it was hidden.
  252.  
  253.     SEE ALSO
  254.         OpenProgressWindow(), HideProgressWindow()
  255.  
  256.